home *** CD-ROM | disk | FTP | other *** search
/ SGI Freeware 2002 November / SGI Freeware 2002 November - Disc 1.iso / dist / fw_apache2.idb / usr / freeware / apache2 / include / mod_cgi.h.z / mod_cgi.h
C/C++ Source or Header  |  2002-07-08  |  5KB  |  101 lines
  1. /* ====================================================================
  2.  * The Apache Software License, Version 1.1
  3.  *
  4.  * Copyright (c) 2000-2002 The Apache Software Foundation.  All rights
  5.  * reserved.
  6.  *
  7.  * Redistribution and use in source and binary forms, with or without
  8.  * modification, are permitted provided that the following conditions
  9.  * are met:
  10.  *
  11.  * 1. Redistributions of source code must retain the above copyright
  12.  *    notice, this list of conditions and the following disclaimer.
  13.  *
  14.  * 2. Redistributions in binary form must reproduce the above copyright
  15.  *    notice, this list of conditions and the following disclaimer in
  16.  *    the documentation and/or other materials provided with the
  17.  *    distribution.
  18.  *
  19.  * 3. The end-user documentation included with the redistribution,
  20.  *    if any, must include the following acknowledgment:
  21.  *       "This product includes software developed by the
  22.  *        Apache Software Foundation (http://www.apache.org/)."
  23.  *    Alternately, this acknowledgment may appear in the software itself,
  24.  *    if and wherever such third-party acknowledgments normally appear.
  25.  *
  26.  * 4. The names "Apache" and "Apache Software Foundation" must
  27.  *    not be used to endorse or promote products derived from this
  28.  *    software without prior written permission. For written
  29.  *    permission, please contact apache@apache.org.
  30.  *
  31.  * 5. Products derived from this software may not be called "Apache",
  32.  *    nor may "Apache" appear in their name, without prior written
  33.  *    permission of the Apache Software Foundation.
  34.  *
  35.  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
  36.  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  37.  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  38.  * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
  39.  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  40.  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  41.  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  42.  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  43.  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  44.  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  45.  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  46.  * SUCH DAMAGE.
  47.  * ====================================================================
  48.  *
  49.  * This software consists of voluntary contributions made by many
  50.  * individuals on behalf of the Apache Software Foundation.  For more
  51.  * information on the Apache Software Foundation, please see
  52.  * <http://www.apache.org/>.
  53.  *
  54.  * Portions of this software are based upon public domain software
  55.  * originally written at the National Center for Supercomputing Applications,
  56.  * University of Illinois, Urbana-Champaign.
  57.  */
  58.  
  59. #ifndef _MOD_CGI_H
  60. #define _MOD_CGI_H 1
  61.  
  62. #include "mod_include.h"
  63.  
  64. typedef enum {RUN_AS_SSI, RUN_AS_CGI} prog_types;
  65.  
  66. typedef struct {
  67.     apr_int32_t          in_pipe;
  68.     apr_int32_t          out_pipe;
  69.     apr_int32_t          err_pipe;
  70.     int                  process_cgi;
  71.     apr_cmdtype_e        cmd_type;
  72.     apr_int32_t          detached;
  73.     prog_types           prog_type;
  74.     apr_bucket_brigade **bb;
  75.     include_ctx_t       *ctx;
  76.     ap_filter_t         *next;
  77. } cgi_exec_info_t;
  78.  
  79. /**
  80.  * Registerable optional function to override CGI behavior;
  81.  * Reprocess the command and arguments to execute the given CGI script.
  82.  * @param cmd Pointer to the command to execute (may be overridden)
  83.  * @param argv Pointer to the arguments to pass (may be overridden)
  84.  * @param r The current request
  85.  * @param p The pool to allocate correct cmd/argv elements within.
  86.  * @param process_cgi Set true if processing r->filename and r->args
  87.  *                    as a CGI invocation, otherwise false
  88.  * @param type Set to APR_SHELLCMD or APR_PROGRAM on entry, may be
  89.  *             changed to invoke the program with alternate semantics.
  90.  * @param detach Should the child start in detached state?  Default is no. 
  91.  * @remark This callback may be registered by the os-specific module 
  92.  * to correct the command and arguments for apr_proc_create invocation
  93.  * on a given os.  mod_cgi will call the function if registered.
  94.  */
  95. APR_DECLARE_OPTIONAL_FN(apr_status_t, ap_cgi_build_command, 
  96.                         (const char **cmd, const char ***argv,
  97.                          request_rec *r, apr_pool_t *p, 
  98.                          cgi_exec_info_t *e_info));
  99.  
  100. #endif /* _MOD_CGI_H */
  101.